<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qdoc-manual-contextcmds.qdoc -->
  <title>Status | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Status</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="prev" href="15-qdoc-commands-navigation.html" />
  <link rel="next" href="17-qdoc-commands-thread.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="15-qdoc-commands-navigation.html">Document Navigation</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="17-qdoc-commands-thread.html">Thread Support</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#abstract-and-qmlabstract">\abstract and \qmlabstract</a></li>
<li class="level1"><a href="#default">\default</a></li>
<li class="level1"><a href="#dontdocument">\dontdocument</a></li>
<li class="level1"><a href="#obsolete">\obsolete</a></li>
<li class="level1"><a href="#internal">\internal</a></li>
<li class="level1"><a href="#preliminary">\preliminary</a></li>
<li class="level1"><a href="#since">\since</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Status</h1>
<span class="subtitle"></span>
<!-- $$$16-qdoc-commands-status.html-description -->
<div class="descr"> <a name="details"></a>
<p>These commands are for indicating that a documented element has some special status. The element could be marked as about to be made obsolete, or that it is simply not to be included in the public interface. The <a href="16-qdoc-commands-status.html#since-command">\since</a> command is for specifying the version number in which a function or class first appeared. The <a href="16-qdoc-commands-status.html#qmlabstract-command">\qmlabstract</a> command is for marking a QML type as an abstract base class.</p>
<a name="abstract-command"></a><a name="qmlabstract-command"></a><a name="abstract-and-qmlabstract"></a>
<h2 id="abstract-and-qmlabstract">\abstract and \qmlabstract</h2>
<p>\abstract is a synonym for the \qmlabstract command. Add this command to the <a href="13-qdoc-commands-topics.html#qmltype-command">\qmltype</a> comment for a QML type when that type is meant to be used <i>only</i> as an abstract base type. When a QML type is abstract, it means that the QML type that can't be instantiated. Instead, the properties in its public API are included in the public properties list on the reference page for each QML type that inherits the abstract QML type. The properties are documented as if they are properties of the inheriting QML type.</p>
<p>Normally, when a QML type is marked with <i>\qmlabstract</i>, it is also marked with <i>\internal</i> so that its reference page is not generated. It the abstract QML type is not marked internal, it will have a reference page in the documentation.</p>
<a name="default-command"></a><a name="default"></a>
<h2 id="default">\default</h2>
<p>The \default command is for marking a QML property as the <a href="../qtqml/qtqml-syntax-objectattributes.html#default-properties">default property</a>. The word <code>default</code> is displayed in the documentation of the property.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \qmlproperty list<span class="operator">&lt;</span>Change<span class="operator">&gt;</span> State<span class="operator">::</span>changes
      This property holds the changes to apply <span class="keyword">for</span> <span class="keyword">this</span> state<span class="operator">.</span>
      \<span class="keyword">default</span>

      By <span class="keyword">default</span> these changes are applied against the <span class="keyword">default</span> state<span class="operator">.</span> If the state
      extends another state<span class="operator">,</span> then the changes are applied against the state being
      extended<span class="operator">.</span>
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>See how QDoc renders this property on the reference page for the <a href="../qtgui/qopenglpaintdevice.html#state-changes">State</a> type.</p>
<a name="dontdocument-command"></a><a name="dontdocument"></a>
<h2 id="dontdocument">\dontdocument</h2>
<p>The \dontdocument command is only used in a dontdocument.qdoc file for a particular module. This file specifies publically declared classes or structs that are not meant to be documented. QDoc will not print warnings about missing \class comments for these classes and structs.</p>
<p>Below you will find the \dontdocument command in the dontdocument.qdoc for widgets:</p>
<pre class="cpp plain">

  / *!
     \dontdocument (QTypeInfo QMetaTypeId)
  * /

</pre>
<a name="obsolete-command"></a><a name="obsolete"></a>
<h2 id="obsolete">\obsolete</h2>
<p>The \obsolete command is for indicating that a function is being deprecated, and it should no longer be used in new code. There is no guarantee for how long it will remain in the library.</p>
<p>The command must stand on its own line.</p>
<p>When generating the reference documentation for a class, QDoc will create and link to a separate page documenting its obsolete functions. Usually an equivalent function is provided as an alternative.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \fn MyClass<span class="operator">::</span>MyObsoleteFunction
      \obsolete

      Use MyNewFunction() instead<span class="operator">.</span>
  <span class="operator">*</span> <span class="operator">/</span>

</pre>
<p>QDoc renders this in <code>myclass-obsolete.html</code> as:</p>
<blockquote>        <h1>Obsolete Members for MyClass</h1>
        <p><b>The following class members are obsolete.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p>
<p>...</p>
<ul>
<li>void MyObsoleteFunction() <code>(obsolete)</code></li>
<li>...</li>
</ul>
        <hr />
        <h2>Member Function Documentation</h2>
        <h3>void MyObsoleteFunction ()</h3>
        <p>Use MyNewFunction() instead.</p>
        <p>...</p>
</blockquote>
<a name="internal-command"></a><a name="internal"></a>
<h2 id="internal">\internal</h2>
<p>The \internal command indicates that the referenced function is not part of the public interface.</p>
<p>The command must stand on its own line.</p>
<p>QDoc ignores the documentation as well as the documented item, when generating the associated class reference documentation.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \internal

      Tries to find the decimal separator<span class="operator">.</span> If it can<span class="char">'t find
      it and the thousand delimiter is != '</span><span class="operator">.</span><span class="char">' it will try to
      find a '</span><span class="operator">.</span><span class="char">';
  * /
  int QDoubleSpinBoxPrivate::findDelimiter
          (const QString &amp;str, int index) const
  {
      int dotindex = str.indexOf(delimiter, index);
      if (dotindex == -1 &amp;&amp; thousand != dot &amp;&amp; delimiter != dot)
          dotindex = str.indexOf(dot, index);
      return dotindex;
  }
  </span>

</pre>
<p>This function will not be included in the documentation.</p>
<a name="preliminary-command"></a><a name="preliminary"></a>
<h2 id="preliminary">\preliminary</h2>
<p>The \preliminary command is for indicating that a referenced function is still under development.</p>
<p>The command must stand on its own line.</p>
<p>The \preliminary command expands to a notification in the function documentation, and marks the function as preliminary when it appears in lists.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \preliminary

      Returns information about the joining type attributes of the
      character (needed <span class="keyword">for</span> certain languages such as Arabic <span class="keyword">or</span>
      Syriac)<span class="operator">.</span>

  <span class="operator">*</span> <span class="operator">/</span>
  <span class="type"><a href="../qtcore/qchar.html">QChar</a></span><span class="operator">::</span>JoiningType <span class="type"><a href="../qtcore/qchar.html">QChar</a></span><span class="operator">::</span>joiningType() <span class="keyword">const</span>
  {
      <span class="keyword">return</span> <span class="type"><a href="../qtcore/qchar.html">QChar</a></span><span class="operator">::</span>joiningType(ucs);
  }

</pre>
<p>QDoc renders this as:</p>
<blockquote>        <h3>
        <a href="http://doc.qt.io/qt-5/qchar.html#JoiningType-enum">JoiningType</a>
        QChar::joiningType() const</h3>
        <p><b>This function is under development and subject to change.</b></p>
<p>Returns information about the joining type attributes of the character (needed for certain languages such as Arabic or Syriac).</p>
</blockquote>
<p>And the function's entry in <a href="../qtcore/qchar.html">QChar</a>'s list of public functions will be rendered as:</p>
<blockquote><ul>
<li>...</li>
<li>JoiningType <a href="../qtcore/qchar.html#joiningType">joiningType</a>() const <code>(preliminary)</code></li>
<li>...</li>
</ul>
</blockquote>
<a name="since-command"></a><a name="since"></a>
<h2 id="since">\since</h2>
<p>The \since command tells in which minor release the associated functionality was added.</p>
<pre class="cpp">

  <span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
      \since <span class="number">4.1</span>

      Returns an icon <span class="keyword">for</span> \a standardIcon<span class="operator">.</span>

      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

      \sa standardPixmap()
  <span class="operator">*</span> <span class="operator">/</span>
  <span class="type"><a href="../qtgui/qicon.html">QIcon</a></span> <span class="type"><a href="../qtwidgets/qstyle.html">QStyle</a></span><span class="operator">::</span>standardIcon(StandardPixmap standardIcon<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="../qtwidgets/qstyleoption.html">QStyleOption</a></span> <span class="operator">*</span>option<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span> <span class="operator">*</span>widget) <span class="keyword">const</span>
  {
  }

</pre>
<p>QDoc renders this as:</p>
<blockquote>        <h3>QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option, const QWidget *widget) const</h3>
        <p>This function was introduced in Qt version 4.1</p>
<p>Returns an icon for <i>standardIcon</i>.</p>
<p>...</p>
<p>See also <a href="../qtwidgets/qstyle-obsolete.html#standardPixmap">standardPixmap()</a>.</p>
</blockquote>
<p>QDoc generates the &quot;Qt&quot; reference from the <a href="25-qdoc-configuration-derivedprojects.html#project"><code>project</code></a> configuration variable. For that reason this reference will change according to the current documentation project.</p>
<p>See also <a href="25-qdoc-configuration-derivedprojects.html#project"><code>project</code></a>.</p>
</div>
<!-- @@@16-qdoc-commands-status.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="15-qdoc-commands-navigation.html">Document Navigation</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="17-qdoc-commands-thread.html">Thread Support</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
